<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>Smoothie Happy</title>
    
    <meta name="description" content="Smoothieware network communication API." />
    
    
    
    <script src="scripts/prettify/prettify.js"></script>
    <script src="scripts/prettify/lang-css.js"></script>
    <script src="scripts/jquery.min.js"></script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css">
    <link type="text/css" rel="stylesheet" href="styles/jaguar.css">
    
    
    <script>
    var config = {"monospaceLinks":true,"cleverLinks":true,"default":{"outputSourceFiles":true},"applicationName":"smoothie-happy","meta":{"title":"Smoothie Happy","description":"Smoothieware network communication API.","keyword":""},"linenums":true};
    </script>
    

    
</head>
<body>
<div id="wrap" class="clearfix">
    
<div class="navigation">
    <h3 class="applicationName"><a href="index.html">smoothie-happy</a></h3>

    <div class="search">
        <input id="search" type="text" class="form-control input-sm" placeholder="Search Documentations">
    </div>
    <ul class="list">
    
        <li class="item" data-name="sh">
            <span class="title">
                <a href="sh.html">sh</a>
                
                <span class="static">static</span>
                
            </span>
            <ul class="members itemMembers">
            
            <span class="subtitle">Members</span>
            
                <li data-name="sh.description"><a href="sh.html#.description">description</a></li>
            
                <li data-name="sh.link"><a href="sh.html#.link">link</a></li>
            
                <li data-name="sh.name"><a href="sh.html#.name">name</a></li>
            
                <li data-name="sh.version"><a href="sh.html#.version">version</a></li>
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="methods itemMembers">
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
        <li class="item" data-name="sh.command">
            <span class="title">
                <a href="sh.command.html">sh.command</a>
                
                <span class="static">static</span>
                
            </span>
            <ul class="members itemMembers">
            
            </ul>
            <ul class="typedefs itemMembers">
            
            <span class="subtitle">Typedefs</span>
            
                <li data-name="sh.command.thermistorSaveCallback"><a href="sh.command.html#.thermistorSaveCallback">thermistorSaveCallback</a></li>
            
            </ul>
            <ul class="methods itemMembers">
            
            <span class="subtitle">Methods</span>
            
                <li data-name="sh.command.abort"><a href="sh.command.html#.abort">abort</a></li>
            
                <li data-name="sh.command.cat"><a href="sh.command.html#.cat">cat</a></li>
            
                <li data-name="sh.command.cd"><a href="sh.command.html#.cd">cd</a></li>
            
                <li data-name="sh.command.checksum"><a href="sh.command.html#.checksum">checksum</a></li>
            
                <li data-name="sh.command.get"><a href="sh.command.html#.get">get</a></li>
            
                <li data-name="sh.command.help"><a href="sh.command.html#.help">help</a></li>
            
                <li data-name="sh.command.kinematics"><a href="sh.command.html#.kinematics">kinematics</a></li>
            
                <li data-name="sh.command.ls"><a href="sh.command.html#.ls">ls</a></li>
            
                <li data-name="sh.command.md5sum"><a href="sh.command.html#.md5sum">md5sum</a></li>
            
                <li data-name="sh.command.mem"><a href="sh.command.html#.mem">mem</a></li>
            
                <li data-name="sh.command.mv"><a href="sh.command.html#.mv">mv</a></li>
            
                <li data-name="sh.command.net"><a href="sh.command.html#.net">net</a></li>
            
                <li data-name="sh.command.ok"><a href="sh.command.html#.ok">ok</a></li>
            
                <li data-name="sh.command.ping"><a href="sh.command.html#.ping">ping</a></li>
            
                <li data-name="sh.command.play"><a href="sh.command.html#.play">play</a></li>
            
                <li data-name="sh.command.position"><a href="sh.command.html#.position">position</a></li>
            
                <li data-name="sh.command.progress"><a href="sh.command.html#.progress">progress</a></li>
            
                <li data-name="sh.command.pwd"><a href="sh.command.html#.pwd">pwd</a></li>
            
                <li data-name="sh.command.remount"><a href="sh.command.html#.remount">remount</a></li>
            
                <li data-name="sh.command.reset"><a href="sh.command.html#.reset">reset</a></li>
            
                <li data-name="sh.command.resetAlarm"><a href="sh.command.html#.resetAlarm">resetAlarm</a></li>
            
                <li data-name="sh.command.resume"><a href="sh.command.html#.resume">resume</a></li>
            
                <li data-name="sh.command.rm"><a href="sh.command.html#.rm">rm</a></li>
            
                <li data-name="sh.command.state"><a href="sh.command.html#.state">state</a></li>
            
                <li data-name="sh.command.status"><a href="sh.command.html#.status">status</a></li>
            
                <li data-name="sh.command.suspend"><a href="sh.command.html#.suspend">suspend</a></li>
            
                <li data-name="sh.command.switch"><a href="sh.command.html#.switch">switch</a></li>
            
                <li data-name="sh.command.temp"><a href="sh.command.html#.temp">temp</a></li>
            
                <li data-name="sh.command.tempGet"><a href="sh.command.html#.tempGet">tempGet</a></li>
            
                <li data-name="sh.command.tempSet"><a href="sh.command.html#.tempSet">tempSet</a></li>
            
                <li data-name="sh.command.thermistorCalc"><a href="sh.command.html#.thermistorCalc">thermistorCalc</a></li>
            
                <li data-name="sh.command.thermistors"><a href="sh.command.html#.thermistors">thermistors</a></li>
            
                <li data-name="sh.command.upload"><a href="sh.command.html#.upload">upload</a></li>
            
                <li data-name="sh.command.version"><a href="sh.command.html#.version">version</a></li>
            
                <li data-name="sh.command.wcs"><a href="sh.command.html#.wcs">wcs</a></li>
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
        <li class="item" data-name="sh.config">
            <span class="title">
                <a href="sh.config.html">sh.config</a>
                
                <span class="static">static</span>
                
            </span>
            <ul class="members itemMembers">
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="methods itemMembers">
            
            <span class="subtitle">Methods</span>
            
                <li data-name="sh.config.cache"><a href="sh.config.html#.cache">cache</a></li>
            
                <li data-name="sh.config.cacheDump"><a href="sh.config.html#.cacheDump">cacheDump</a></li>
            
                <li data-name="sh.config.cacheLoad"><a href="sh.config.html#.cacheLoad">cacheLoad</a></li>
            
                <li data-name="sh.config.cacheUnload"><a href="sh.config.html#.cacheUnload">cacheUnload</a></li>
            
                <li data-name="sh.config.format"><a href="sh.config.html#.format">format</a></li>
            
                <li data-name="sh.config.get"><a href="sh.config.html#.get">get</a></li>
            
                <li data-name="sh.config.getAll"><a href="sh.config.html#.getAll">getAll</a></li>
            
                <li data-name="sh.config.load"><a href="sh.config.html#.load">load</a></li>
            
                <li data-name="sh.config.parse"><a href="sh.config.html#.parse">parse</a></li>
            
                <li data-name="sh.config.save"><a href="sh.config.html#.save">save</a></li>
            
                <li data-name="sh.config.set"><a href="sh.config.html#.set">set</a></li>
            
                <li data-name="sh.config.upgrade"><a href="sh.config.html#.upgrade">upgrade</a></li>
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
        <li class="item" data-name="sh.firmware">
            <span class="title">
                <a href="sh.firmware.html">sh.firmware</a>
                
                <span class="static">static</span>
                
            </span>
            <ul class="members itemMembers">
            
            <span class="subtitle">Members</span>
            
                <li data-name="sh.firmware.edge"><a href="sh.firmware.html#.edge">edge</a></li>
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="methods itemMembers">
            
            <span class="subtitle">Methods</span>
            
                <li data-name="sh.firmware.getCommitPosition"><a href="sh.firmware.html#.getCommitPosition">getCommitPosition</a></li>
            
                <li data-name="sh.firmware.getCommits"><a href="sh.firmware.html#.getCommits">getCommits</a></li>
            
                <li data-name="sh.firmware.getFirmware"><a href="sh.firmware.html#.getFirmware">getFirmware</a></li>
            
                <li data-name="sh.firmware.update"><a href="sh.firmware.html#.update">update</a></li>
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
        <li class="item" data-name="sh.network">
            <span class="title">
                <a href="sh.network.html">sh.network</a>
                
                <span class="static">static</span>
                
            </span>
            <ul class="members itemMembers">
            
            <span class="subtitle">Members</span>
            
                <li data-name="sh.network.timeout"><a href="sh.network.html#.timeout">timeout</a></li>
            
            </ul>
            <ul class="typedefs itemMembers">
            
            <span class="subtitle">Typedefs</span>
            
                <li data-name="sh.network.onlineCallback"><a href="sh.network.html#.onlineCallback">onlineCallback</a></li>
            
                <li data-name="sh.network.ontryCallback"><a href="sh.network.html#.ontryCallback">ontryCallback</a></li>
            
                <li data-name="sh.network.parserCallback"><a href="sh.network.html#.parserCallback">parserCallback</a></li>
            
                <li data-name="sh.network.responseCallback"><a href="sh.network.html#.responseCallback">responseCallback</a></li>
            
            </ul>
            <ul class="methods itemMembers">
            
            <span class="subtitle">Methods</span>
            
                <li data-name="sh.network.command"><a href="sh.network.html#.command">command</a></li>
            
                <li data-name="sh.network.get"><a href="sh.network.html#.get">get</a></li>
            
                <li data-name="sh.network.post"><a href="sh.network.html#.post">post</a></li>
            
                <li data-name="sh.network.request"><a href="sh.network.html#.request">request</a></li>
            
                <li data-name="sh.network.upload"><a href="sh.network.html#.upload">upload</a></li>
            
                <li data-name="sh.network.waitUntilOnline"><a href="sh.network.html#.waitUntilOnline">waitUntilOnline</a></li>
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
        <li class="item" data-name="sh.scanner">
            <span class="title">
                <a href="sh.scanner.html">sh.scanner</a>
                
                <span class="static">static</span>
                
            </span>
            <ul class="members itemMembers">
            
            <span class="subtitle">Members</span>
            
                <li data-name="sh.scanner.aborted"><a href="sh.scanner.html#.aborted">aborted</a></li>
            
                <li data-name="sh.scanner.boards"><a href="sh.scanner.html#.boards">boards</a></li>
            
                <li data-name="sh.scanner.found"><a href="sh.scanner.html#.found">found</a></li>
            
                <li data-name="sh.scanner.input"><a href="sh.scanner.html#.input">input</a></li>
            
                <li data-name="sh.scanner.queue"><a href="sh.scanner.html#.queue">queue</a></li>
            
                <li data-name="sh.scanner.scanned"><a href="sh.scanner.html#.scanned">scanned</a></li>
            
                <li data-name="sh.scanner.scanning"><a href="sh.scanner.html#.scanning">scanning</a></li>
            
                <li data-name="sh.scanner.timeout"><a href="sh.scanner.html#.timeout">timeout</a></li>
            
                <li data-name="sh.scanner.total"><a href="sh.scanner.html#.total">total</a></li>
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="methods itemMembers">
            
            <span class="subtitle">Methods</span>
            
                <li data-name="sh.scanner.abort"><a href="sh.scanner.html#.abort">abort</a></li>
            
                <li data-name="sh.scanner.onabort"><a href="sh.scanner.html#.onabort">onabort</a></li>
            
                <li data-name="sh.scanner.onboard"><a href="sh.scanner.html#.onboard">onboard</a></li>
            
                <li data-name="sh.scanner.onend"><a href="sh.scanner.html#.onend">onend</a></li>
            
                <li data-name="sh.scanner.onprogress"><a href="sh.scanner.html#.onprogress">onprogress</a></li>
            
                <li data-name="sh.scanner.onresume"><a href="sh.scanner.html#.onresume">onresume</a></li>
            
                <li data-name="sh.scanner.onstart"><a href="sh.scanner.html#.onstart">onstart</a></li>
            
                <li data-name="sh.scanner.onstop"><a href="sh.scanner.html#.onstop">onstop</a></li>
            
                <li data-name="sh.scanner.processQueue"><a href="sh.scanner.html#.processQueue">processQueue</a></li>
            
                <li data-name="sh.scanner.resume"><a href="sh.scanner.html#.resume">resume</a></li>
            
                <li data-name="sh.scanner.scan"><a href="sh.scanner.html#.scan">scan</a></li>
            
                <li data-name="sh.scanner.setInput"><a href="sh.scanner.html#.setInput">setInput</a></li>
            
                <li data-name="sh.scanner.setTimeout"><a href="sh.scanner.html#.setTimeout">setTimeout</a></li>
            
                <li data-name="sh.scanner.stop"><a href="sh.scanner.html#.stop">stop</a></li>
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
    </ul>
</div>
    <div class="main">
        <h1 class="page-title" data-filename="sh.config.html">Namespace: config</h1>
        



<section>
    
<header>
    <h2>
        <span class="ancestors"><a href="sh.html">sh</a>.</span>
    
    config
    </h2>
    
</header>  

<article>
    <div class="container-overview">
    
    
    
        
            <div class="description"><p>Configuration module.</p></div>
        
        
        
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

        
        
    
    </div>
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        <h3 class="subsection-title">Methods</h3>
        
        <dl>
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".cache">
            
            <span class="type-signature static">static</span>sh.config.cache<span class="signature">(ip, action, settings)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{XMLHttpRequest}</span>
        </h4>
    
        
        <div class="tag-source">
            <a href="smoothie-happy.js.html">smoothie-happy.js</a>, <a href="smoothie-happy.js.html#line801">line 801</a>
        </div>
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>Load/unload/dump configuration cache.</p>
    </div>
    

    
    
    
    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>ip</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>Board ip.</p></td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>action</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>Possible values [load|unload|dump].</p></td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>settings</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>See &quot;<a href="sh.network.html#.command"><code>sh.network.command</code></a>.settings&quot;.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    


    
    
    
</dd>

        
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".cacheDump">
            
            <span class="type-signature static">static</span>sh.config.cacheDump<span class="signature">(ip, settings)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{XMLHttpRequest}</span>
        </h4>
    
        
        <div class="tag-source">
            <a href="smoothie-happy.js.html">smoothie-happy.js</a>, <a href="smoothie-happy.js.html#line862">line 862</a>
        </div>
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>Dump configuration cache.</p>
    </div>
    

    
    
    
    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>ip</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>Board ip.</p></td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>settings</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>See &quot;<a href="sh.network.html#.command"><code>sh.network.command</code></a>.settings&quot;.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    


    
    
    
</dd>

        
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".cacheLoad">
            
            <span class="type-signature static">static</span>sh.config.cacheLoad<span class="signature">(ip, settings)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{XMLHttpRequest}</span>
        </h4>
    
        
        <div class="tag-source">
            <a href="smoothie-happy.js.html">smoothie-happy.js</a>, <a href="smoothie-happy.js.html#line840">line 840</a>
        </div>
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>Load configuration cache.</p>
    </div>
    

    
    
    
    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>ip</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>Board ip.</p></td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>settings</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>See &quot;<a href="sh.network.html#.command"><code>sh.network.command</code></a>.settings&quot;.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    


    
    
    
</dd>

        
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".cacheUnload">
            
            <span class="type-signature static">static</span>sh.config.cacheUnload<span class="signature">(ip, settings)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{XMLHttpRequest}</span>
        </h4>
    
        
        <div class="tag-source">
            <a href="smoothie-happy.js.html">smoothie-happy.js</a>, <a href="smoothie-happy.js.html#line851">line 851</a>
        </div>
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>Unload configuration cache.</p>
    </div>
    

    
    
    
    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>ip</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>Board ip.</p></td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>settings</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>See &quot;<a href="sh.network.html#.command"><code>sh.network.command</code></a>.settings&quot;.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    


    
    
    
</dd>

        
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".format">
            
            <span class="type-signature static">static</span>sh.config.format<span class="signature">(config)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{String}</span>
        </h4>
    
        
        <div class="tag-source">
            <a href="smoothie-happy.js.html">smoothie-happy.js</a>, <a href="smoothie-happy.js.html#line471">line 471</a>
        </div>
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>Format parsed configuration.</p>
    </div>
    

    
    
    
    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>config</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>Configuration object provided by <a href="sh.config.html#.parse"><code>sh.config.parse</code></a>.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    


<h5>Returns:</h5>
configuration file.
<br />

    
    
    
</dd>

        
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".get">
            
            <span class="type-signature static">static</span>sh.config.get<span class="signature">(ip, <span class="optional">name</span>, settings)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{XMLHttpRequest}</span>
        </h4>
    
        
        <div class="tag-source">
            <a href="smoothie-happy.js.html">smoothie-happy.js</a>, <a href="smoothie-happy.js.html#line644">line 644</a>
        </div>
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>Get config value.</p>
    </div>
    

    
    
    
    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>ip</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                    
                    
                        
                    
                
                <p>Board ip.</p></td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>name</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                    
                        <span class="optional">optional</span>
                    
                    
                        
                    
                
                <p>Setting name, if not set return all items (take long time).</p></td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>settings</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>
            
            
            
            <td class="description last">
                
                    
                    
                        
                    
                
                <p>See &quot;<a href="sh.network.html#.command"><code>sh.network.command</code></a>.settings&quot;.</p>
                

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>location</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>Where to read the value {@default 'sd'}.</p></td>
        </tr>
	
	
	</tbody>
</table>
            </td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    


    
    
    
</dd>

        
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".getAll">
            
            <span class="type-signature static">static</span>sh.config.getAll<span class="signature">(ip, settings)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{XMLHttpRequest}</span>
        </h4>
    
        
        <div class="tag-source">
            <a href="smoothie-happy.js.html">smoothie-happy.js</a>, <a href="smoothie-happy.js.html#line618">line 618</a>
        </div>
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>Get configuration from file.</p>
    </div>
    

    
    
    
    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>ip</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>Board ip.</p></td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>settings</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>See &quot;<a href="sh.network.html#.command"><code>sh.network.command</code></a>.settings&quot;.</p>
                

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>timeout</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Mixed</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>Connexion timeout {@default 60000}.</p></td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>filename</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Mixed</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>Configuration filename relative to sd card root directory {@default 'config.txt'}.</p></td>
        </tr>
	
	
	</tbody>
</table>
            </td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    


    
    
    
</dd>

        
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".load">
            
            <span class="type-signature static">static</span>sh.config.load<span class="signature">(ip, <span class="optional">filename</span>, settings)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{XMLHttpRequest}</span>
        </h4>
    
        
        <div class="tag-source">
            <a href="smoothie-happy.js.html">smoothie-happy.js</a>, <a href="smoothie-happy.js.html#line763">line 763</a>
        </div>
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>loads a configuration override file from specified name or config-override.</p>
    </div>
    

    
    
    
    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>ip</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                    
                    
                        
                    
                
                <p>Board ip.</p></td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>filename</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                    
                        <span class="optional">optional</span>
                    
                    
                        
                    
                
                <p>Target config-override filename.</p></td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>settings</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>
            
            
            
            <td class="description last">
                
                    
                    
                        
                    
                
                <p>See &quot;<a href="sh.network.html#.command"><code>sh.network.command</code></a>.settings&quot;.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    


    
    
    
</dd>

        
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".parse">
            
            <span class="type-signature static">static</span>sh.config.parse<span class="signature">(raw)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
        </h4>
    
        
        <div class="tag-source">
            <a href="smoothie-happy.js.html">smoothie-happy.js</a>, <a href="smoothie-happy.js.html#line337">line 337</a>
        </div>
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>Parse raw configuration.</p>
    </div>
    

    
    
    
    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>raw</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>Raw configuration.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    


    
    
    
</dd>

        
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".save">
            
            <span class="type-signature static">static</span>sh.config.save<span class="signature">(ip, <span class="optional">filename</span>, settings)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{XMLHttpRequest}</span>
        </h4>
    
        
        <div class="tag-source">
            <a href="smoothie-happy.js.html">smoothie-happy.js</a>, <a href="smoothie-happy.js.html#line734">line 734</a>
        </div>
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>Saves a configuration override file as specified filename or as config-override.</p>
    </div>
    

    
    
    
    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>ip</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                    
                    
                        
                    
                
                <p>Board ip.</p></td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>filename</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                    
                        <span class="optional">optional</span>
                    
                    
                        
                    
                
                <p>Target config-override filename.</p></td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>settings</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>
            
            
            
            <td class="description last">
                
                    
                    
                        
                    
                
                <p>See &quot;<a href="sh.network.html#.command"><code>sh.network.command</code></a>.settings&quot;.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    


    
    
    
</dd>

        
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".set">
            
            <span class="type-signature static">static</span>sh.config.set<span class="signature">(ip, name, value, settings)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{XMLHttpRequest}</span>
        </h4>
    
        
        <div class="tag-source">
            <a href="smoothie-happy.js.html">smoothie-happy.js</a>, <a href="smoothie-happy.js.html#line691">line 691</a>
        </div>
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>Set config value.</p>
    </div>
    

    
    
    
    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>ip</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>Board ip.</p></td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>name</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>Setting name.</p></td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>value</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>Setting value.</p></td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>settings</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>See &quot;<a href="sh.network.html#.command"><code>sh.network.command</code></a>.settings&quot;.</p>
                

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>location</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>Where to write the value {@default 'sd'}.</p></td>
        </tr>
	
	
	</tbody>
</table>
            </td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    


    
    
    
</dd>

        
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".upgrade">
            
            <span class="type-signature static">static</span>sh.config.upgrade<span class="signature">(ip, settings)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{XMLHttpRequest}</span>
        </h4>
    
        
        <div class="tag-source">
            <a href="smoothie-happy.js.html">smoothie-happy.js</a>, <a href="smoothie-happy.js.html#line594">line 594</a>
        </div>
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>Upgrade the configuration file.</p>
    </div>
    

    
    
    
    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>ip</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>Board ip.</p></td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>settings</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>See &quot;<a href="sh.network.html#.request"><code>sh.network.request</code></a>.settings&quot;.</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    

    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    


    
    
    
</dd>

        </dl>
    
    
    
    
    
</article>

</section>  





        

        <footer>
            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Wed Apr 27 2016 11:37:40 GMT+0200 (Europe de l’Ouest (heure d’été))
        </footer>
    </div>
</div>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
<script src="scripts/main.js"></script>
</body>
</html>